The Design Notes API > The Design Notes JavaScript API > MMNotes.getKeys()

 

MMNotes.getKeys()

Description

Gets a list of all the keys in a Design Notes file.

Arguments

fileHandle

The argument is the file handle returned by MMNotes.open().

Returns

An array of strings, each containing the name of a key.

Example

The following code might be used in a custom floating panel to display the Design Notes information for the active document:

var noteHandle = MMNotes.open(dw.getDocumentDOM().URL);
var theKeys = MMNotes.getKeys(noteHandle);
var noteString = "";
var theValue = "";
for (var i=0; i < theKeys.length; i++){
	theValue = MMNotes.get(noteHandle,theKeys[i]);
	noteString +=  theKeys[i] + " = " theValue + "\n";
}
document.theForm.bigTextField.value = noteString;